Refactor CommandContributionItemParameter initialization to use supported constructor API#4068
Merged
Conversation
Contributor
Author
|
@HeikoKlare |
Contributor
Contributor
|
One less warning. Thank you! 
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the WorkbenchActionBuilder#getItem(...) implementation to replace usage of the deprecated/internal CommandContributionItemParameter constructor with the currently supported constructor pattern.
Changes
Replaced the constructor invocation that accepted multiple UI-related parameters (icon, disabledIcon, label, tooltip, etc.).
Switched to using the supported constructor:
new CommandContributionItemParameter(
getWindow(),
actionId,
commandId,
CommandContributionItem.STYLE_PUSH
);
Populated UI attributes (icon, disabledIcon, label, and tooltip) through the parameter object's fields after construction.
Preserved existing functionality and behavior of the contributed command item.
Reason for Change
The previous implementation triggered an API tooling error:
"WorkbenchActionBuilder illegally references constructor CommandContributionItemParameter(IServiceLocator, String, String, Map, ImageDescriptor, ImageDescriptor, ImageDescriptor, String, String, String, int, String, boolean)"
The existing implementation triggered an Eclipse API tooling error because of the constructor used to create CommandContributionItemParameter. This update adopts a constructor pattern that complies with API tooling validation and initializes presentation-related properties separately. The resulting command contribution behaves the same as before while eliminating the validation issue.
Impact
Created this as a separate change as suggested via #4061 (review)